4.3 - 二次开发API

GoMinerProxy 的API文档（v1.1.0版本，如部分新版功能未能更新可浏览器F12进行分析）

描述：登录

请求URL：http://<domain_name>:<port>/api/auth/login

请求方式：POST

参数：

参数名 必选 类型 说明
password 是 string 登录密码

返回示例：

{
    "code": 200,
    "expire": "2022-01-01T00:00:00+08:00",
    "token": "**********"
}

返回参数说明：

参数名 类型 说明
code int 200：为成功；400：为失败
expire int64 token过期时间
token string Json Web Token，鉴权用

备注：Json Web Token过期时间为1天，超时后需重新登录获取

描述：获取主页信息

请求URL：http://<domain_name>:<port>/api/pool/dashboard

请求方式：GET

参数：无

Header：可以参考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

参数名 必选 类型 说明
Authorization 是 string 登录时获取的token，填写：Bearer[空格]Token

返回示例：

{
    "activeProxyCount": ***,
    "minerCount": ***,
    "processedJobs": *******,
    "processedSubmits": *******,
    "startTime": **********,
    "totalHashrate": ********
}

返回参数说明：

参数名 类型 说明
activeProxyCount int 活跃代理池数
minerCount int 在线矿机数
processedJobs int64 已分配任务数
processedSubmits int64 已提交贡献数
startTime int64 时间戳，服务端开启时间
totalHashrate int64 总算力(单位H/s)

备注：无

描述：获取服务器设置信息

请求URL：http://<domain_name>:<port>/api/pool/setting

请求方式：GET

参数：无

Header：可以参考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

参数名 必选 类型 说明
Authorization 是 string 登录时获取的token，填写：Bearer[空格]Token

返回示例：

{
    "password": "********",
    "version": "*******",
    "webPort": 9998
}

返回参数说明：

参数名 类型 说明
password string 登录密码
version string 当前服务端版本号
webPort int 网页使用的端口

备注：无

描述：获取公告信息

请求URL：http://<domain_name>:<port>/api/pool/announcement

请求方式：GET

参数：无

Header：可以参考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

参数名 必选 类型 说明
Authorization 是 string 登录时获取的token，填写：Bearer[空格]Token

返回示例：

{
    "raw": "********"
}

返回参数说明：

参数名 类型 说明
raw string markdown格式的公告信息

备注：无

描述：获取代理池列表

请求URL：http://<domain_name>:<port>/api/pool/proxyList

请求方式：GET

参数：无

Header：可以参考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

参数名 必选 类型 说明
Authorization 是 string 登录时获取的token，填写：Bearer[空格]Token

返回示例：

[
    {
        "activeMinerCount": *,
        "name": "************",
        "pool": {
            "domain": "****************",
            "name": "**********"
        },
        "port": *****,
        "running": true
    }
]

返回参数说明：

参数名 类型 说明
activeMinerCount int 该代理池目前链接的矿机数
name string 该代理池名称
pool-domain string 该代理池代理的矿池域名
pool-name string 该代理池代理的矿池名称
port int 该代理池的端口
running boolean 该代理池的运行状态

备注：无

描述：获取可代理的矿池列表

请求URL：http://<domain_name>:<port>/api/pool/upperPeers

请求方式：GET

参数：无

Header：可以参考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

参数名 必选 类型 说明
Authorization 是 string 登录时获取的token，填写：Bearer[空格]Token

返回示例：

[
    {
        "domain": "eth.f2pool.com",
        "id": 0,
        "name": "鱼池"
    }
]

返回参数说明：

参数名 类型 说明
domain string 代理的矿池域名
id int 代理的矿池ID
name string 代理的矿池名称

备注：无

描述：获取代理池配置信息

请求URL：http://<domain_name>:<port>/api/pool/proxy/config?name=<proxy_name>

请求方式：GET

参数：无

Header：可以参考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

参数名 必选 类型 说明
Authorization 是 string 登录时获取的token，填写：Bearer[空格]Token

返回示例：

{
    "name": "*****",
    "listenPort": ****,
    "poolIndex": *,
    "reconnectDelay": *,
    "feeLogic": *,
    "fees": [
        {
            "loginName": "*************************",
            "workerName": "****",
            "fee": *
        }
    ]
}

返回参数说明：

参数名 类型 说明
name string 该代理池的名称
listenPort int 该代理池的端口
poolIndex int 上游矿池ID，可以从upperPeer获取
reconnectDelay int 抽水延迟，暂未使用，默认0
feeLogic int 抽水逻辑，1：单矿机平均抽水；3：单矿机随机抽水
fees-loginName string 该代理池抽水钱包地址
fees-workerName string 该代理池抽水矿机名
fees-fee int 该代理池抽水的比例(单位:千分之一)

备注：无

描述：获取代理池链接的矿机信息

请求URL：http://<domain_name>:<port>/api/pool/proxy/miners?name=<proxy_name>

请求方式：GET

参数：无

Header：可以参考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

参数名 必选 类型 说明
Authorization 是 string 登录时获取的token，填写：Bearer[空格]Token

返回示例：

[
    {
        "address": "***.***.***.***:*****",
        "connectTime": **********,
        "feeSubmits": **,
        "hashrate": *******,
        "lastSubmitDelay": *,
        "loginName": "************************",
        "submits": ***,
        "workerName": "***"
    }
]

返回参数说明：

参数名 类型 说明
address string 矿机的IP地址和端口
connectTime int64 矿机的连接时间戳
feeSubmits int64 矿机的抽水份额
hashrate int64 矿机的算力
lastSubmitDelay int 提交延迟
loginName string 矿机钱包地址
submits int64 矿机的提交份额
workerName string 矿机名

备注：无

描述：获取服务器运行日志

请求URL：http://<domain_name>:<port>/api/pool/logs

请求方式：GET

参数：无

Header：可以参考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

参数名 必选 类型 说明
Authorization 是 string 登录时获取的token，填写：Bearer[空格]Token

返回示例：

{
    "logs": [
        {
            "message": "*****************************************",
            "prefix": "****",
            "time": *********,
            "type": 0
        }
    ]
}

返回参数说明：

参数名 类型 说明
message string 一行日志的具体信息
prefix string 一行日志的关键程度
time int64 一行日志的时间戳
type int 一行日志的类型

备注：无

描述：创建代理池

请求URL：http://<domain_name>:<port>/api/pool/proxy/create

请求方式：POST

请求示例：

{
    "feeLogic": 3,
    "fees": [
        {
            "fee": 15,
            "loginName": "gominerproxy",
            "workerName": "test"
        }
    ],
    "listenPort": 60004,
    "name": "test",
    "poolIndex": 0,
    "reconnectDelay": 0
}

参数：

参数名 必选 类型 说明
feeLogic 是 string 抽水逻辑，1：单矿机平均抽水；3：单矿机随机抽水
fees-fee 否 int 该代理池抽水的比例(单位:千分之一)
fees-loginName 否 string 该代理池抽水钱包地址
fees-workerName 否 string 该代理池抽水矿机名
listenPort 是 int 该代理池的端口
name 是 string 该代理池的名称
poolIndex 是 int 上游矿池ID，可以从upperPeer获取
reconnectDelay 是 int 抽水延迟，暂未使用，默认0

Header：可以参考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

参数名 必选 类型 说明
Authorization 是 string 登录时获取的token，填写：Bearer[空格]Token

返回示例：

{
    "code": 0,
    "error": null
}

返回参数说明：

参数名 类型 说明
code int 0：成功；1：失败
error string 错误原因

备注：无

描述：删除代理池

请求URL：http://<domain_name>:<port>/api/pool/proxy/delete?name=<proxy_name>

请求方式：POST

请求示例：

{
    "name": "test"
}

参数：

参数名 必选 类型 说明
name 是 string 该代理池的名称

Header：可以参考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

参数名 必选 类型 说明
Authorization 是 string 登录时获取的token，填写：Bearer[空格]Token

返回示例：

{
    "code": 0,
    "error": null
}

返回参数说明：

参数名 类型 说明
code int 0：成功；1：失败
error string 错误原因

备注：无

描述：启动代理池

请求URL：http://<domain_name>:<port>/api/pool/proxy/start?name=<proxy_name>

请求方式：POST

Header：可以参考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

参数名 必选 类型 说明
Authorization 是 string 登录时获取的token，填写：Bearer[空格]Token

返回示例：

{
    "code": 0,
    "error": null
}

返回参数说明：

参数名 类型 说明
code int 0：成功；1：失败
error string 错误原因

备注：无

描述：停止代理池

请求URL：http://<domain_name>:<port>/api/pool/proxy/stop?name=<proxy_name>

请求方式：POST

Header：可以参考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

参数名 必选 类型 说明
Authorization 是 string 登录时获取的token，填写：Bearer[空格]Token

返回示例：

{
    "code": 0,
    "error": null
}

返回参数说明：

参数名 类型 说明
code int 0：成功；1：失败
error string 错误原因

备注：无

results matching ""

    No results matching ""